-
Notifications
You must be signed in to change notification settings - Fork 31
/
StatefulCustomMappingTransformer`3.xml
196 lines (196 loc) · 12.1 KB
/
StatefulCustomMappingTransformer`3.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<Type Name="StatefulCustomMappingTransformer<TSrc,TDst,TState>" FullName="Microsoft.ML.Transforms.StatefulCustomMappingTransformer<TSrc,TDst,TState>">
<TypeSignature Language="C#" Value="public sealed class StatefulCustomMappingTransformer<TSrc,TDst,TState> : Microsoft.ML.ITransformer where TSrc : class, new() where TDst : class, new() where TState : class, new()" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit StatefulCustomMappingTransformer`3<class .ctor TSrc, class .ctor TDst, class .ctor TState> extends System.Object implements class Microsoft.ML.ICanSaveModel, class Microsoft.ML.ITransformer" />
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class StatefulCustomMappingTransformer(Of TSrc, TDst, TState)
Implements ITransformer" />
<TypeSignature Language="F#" Value="type StatefulCustomMappingTransformer<'Src, 'Dst, 'State (requires 'Src : null and 'Src : (new : unit -> 'Src) and 'Dst : null and 'Dst : (new : unit -> 'Dst) and 'State : null and 'State : (new : unit -> 'State))> = class
 interface ITransformer
 interface ICanSaveModel" />
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TSrc">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TDst">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TState">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ML.ICanSaveModel</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.ML.ITransformer</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TSrc">The class defining which columns to take from the incoming data.</typeparam>
<typeparam name="TDst">The class defining which new columns are added to the data.</typeparam>
<typeparam name="TState">The type that describes per-cursor state.</typeparam>
<summary>
<see cref="T:Microsoft.ML.ITransformer" /> resulting from fitting an <see cref="T:Microsoft.ML.Transforms.StatefulCustomMappingEstimator`3" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetOutputSchema">
<MemberSignature Language="C#" Value="public Microsoft.ML.DataViewSchema GetOutputSchema (Microsoft.ML.DataViewSchema inputSchema);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ML.DataViewSchema GetOutputSchema(class Microsoft.ML.DataViewSchema inputSchema) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3.GetOutputSchema(Microsoft.ML.DataViewSchema)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOutputSchema (inputSchema As DataViewSchema) As DataViewSchema" />
<MemberSignature Language="F#" Value="abstract member GetOutputSchema : Microsoft.ML.DataViewSchema -> Microsoft.ML.DataViewSchema
override this.GetOutputSchema : Microsoft.ML.DataViewSchema -> Microsoft.ML.DataViewSchema" Usage="statefulCustomMappingTransformer.GetOutputSchema inputSchema" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ML.ITransformer.GetOutputSchema(Microsoft.ML.DataViewSchema)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.DataViewSchema</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputSchema" Type="Microsoft.ML.DataViewSchema" />
</Parameters>
<Docs>
<param name="inputSchema">To be added.</param>
<summary>
Returns the <see cref="T:Microsoft.ML.DataViewSchema" /> which would be produced by the transformer applied to
an input data with schema <paramref name="inputSchema" />.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ML.ICanSaveModel.Save">
<MemberSignature Language="C#" Value="void ICanSaveModel.Save (Microsoft.ML.ModelSaveContext ctx);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void Microsoft.ML.ICanSaveModel.Save(class Microsoft.ML.ModelSaveContext ctx) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3.Microsoft#ML#ICanSaveModel#Save(Microsoft.ML.ModelSaveContext)" />
<MemberSignature Language="VB.NET" Value="Sub Save (ctx As ModelSaveContext) Implements ICanSaveModel.Save" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ML.ICanSaveModel.Save : Microsoft.ML.ModelSaveContext -> unit
override this.Microsoft.ML.ICanSaveModel.Save : Microsoft.ML.ModelSaveContext -> unit" Usage="statefulCustomMappingTransformer.Microsoft.ML.ICanSaveModel.Save ctx" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ML.ICanSaveModel.Save(Microsoft.ML.ModelSaveContext)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ctx" Type="Microsoft.ML.ModelSaveContext" />
</Parameters>
<Docs>
<param name="ctx">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ML.ITransformer.GetRowToRowMapper">
<MemberSignature Language="C#" Value="Microsoft.ML.Data.IRowToRowMapper ITransformer.GetRowToRowMapper (Microsoft.ML.DataViewSchema inputSchema);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class Microsoft.ML.Data.IRowToRowMapper Microsoft.ML.ITransformer.GetRowToRowMapper(class Microsoft.ML.DataViewSchema inputSchema) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3.Microsoft#ML#ITransformer#GetRowToRowMapper(Microsoft.ML.DataViewSchema)" />
<MemberSignature Language="VB.NET" Value="Function GetRowToRowMapper (inputSchema As DataViewSchema) As IRowToRowMapper Implements ITransformer.GetRowToRowMapper" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ML.ITransformer.GetRowToRowMapper : Microsoft.ML.DataViewSchema -> Microsoft.ML.Data.IRowToRowMapper
override this.Microsoft.ML.ITransformer.GetRowToRowMapper : Microsoft.ML.DataViewSchema -> Microsoft.ML.Data.IRowToRowMapper" Usage="statefulCustomMappingTransformer.Microsoft.ML.ITransformer.GetRowToRowMapper inputSchema" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ML.ITransformer.GetRowToRowMapper(Microsoft.ML.DataViewSchema)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.Data.IRowToRowMapper</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inputSchema" Type="Microsoft.ML.DataViewSchema" />
</Parameters>
<Docs>
<param name="inputSchema">To be added.</param>
<summary>
Constructs a row-to-row mapper based on an input schema. If <see cref="P:Microsoft.ML.ITransformer.IsRowToRowMapper" />
is <c>false</c>, then an exception is thrown. If the <paramref name="inputSchema" /> is in any way
unsuitable for constructing the mapper, an exception is likewise thrown.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ML.ITransformer.IsRowToRowMapper">
<MemberSignature Language="C#" Value="bool Microsoft.ML.ITransformer.IsRowToRowMapper { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Microsoft.ML.ITransformer.IsRowToRowMapper" />
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3.Microsoft#ML#ITransformer#IsRowToRowMapper" />
<MemberSignature Language="VB.NET" Value=" ReadOnly Property IsRowToRowMapper As Boolean Implements ITransformer.IsRowToRowMapper" />
<MemberSignature Language="F#" Value="member this.Microsoft.ML.ITransformer.IsRowToRowMapper : bool" Usage="Microsoft.ML.ITransformer.IsRowToRowMapper" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.ML.ITransformer.IsRowToRowMapper</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Whether a call to <see cref="M:Microsoft.ML.ITransformer.GetRowToRowMapper(Microsoft.ML.DataViewSchema)" /> should succeed, on an
appropriate schema.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Transform">
<MemberSignature Language="C#" Value="public Microsoft.ML.IDataView Transform (Microsoft.ML.IDataView input);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ML.IDataView Transform(class Microsoft.ML.IDataView input) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Transforms.StatefulCustomMappingTransformer`3.Transform(Microsoft.ML.IDataView)" />
<MemberSignature Language="VB.NET" Value="Public Function Transform (input As IDataView) As IDataView" />
<MemberSignature Language="F#" Value="abstract member Transform : Microsoft.ML.IDataView -> Microsoft.ML.IDataView
override this.Transform : Microsoft.ML.IDataView -> Microsoft.ML.IDataView" Usage="statefulCustomMappingTransformer.Transform input" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ML.ITransformer.Transform(Microsoft.ML.IDataView)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ML.Transforms</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ML.IDataView</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="input" Type="Microsoft.ML.IDataView" />
</Parameters>
<Docs>
<param name="input">To be added.</param>
<summary>
Take the data in, make transformations, output the data.
Note that <see cref="T:Microsoft.ML.IDataView" />'s are lazy, so no actual transformations happen here, just schema validation.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>